@contentful/rich-text-types

What is @contentful/rich-text-types?

@contentful/rich-text-types is a TypeScript library that provides type definitions for the Contentful Rich Text field type. It allows developers to work with Contentful's rich text data in a type-safe manner, ensuring that the data structures are correctly handled and manipulated.

What are @contentful/rich-text-types's main functionalities?

Type Definitions for Rich Text Nodes

This feature provides type definitions for different types of rich text nodes, such as blocks, inlines, and marks. The code sample demonstrates how to define a paragraph block with bold text.

import { BLOCKS, INLINES, MARKS } from '@contentful/rich-text-types';

const node = {
  nodeType: BLOCKS.PARAGRAPH,
  content: [
    {
      nodeType: 'text',
      value: 'Hello, world!',
      marks: [{ type: MARKS.BOLD }],
      data: {}
    }
  ],
  data: {}
};

Type Definitions for Rich Text Document

This feature provides type definitions for the entire rich text document structure. The code sample shows how to define a simple document with a single paragraph.

import { Document } from '@contentful/rich-text-types';

const document: Document = {
  nodeType: 'document',
  data: {},
  content: [
    {
      nodeType: 'paragraph',
      content: [
        {
          nodeType: 'text',
          value: 'This is a paragraph.',
          marks: [],
          data: {}
        }
      ],
      data: {}
    }
  ]
};

Type Definitions for Rich Text Marks

This feature provides type definitions for text marks such as bold and italic. The code sample demonstrates how to use these type definitions.

import { MARKS } from '@contentful/rich-text-types';

const boldMark = MARKS.BOLD;
const italicMark = MARKS.ITALIC;

Other packages similar to @contentful/rich-text-types

draft-js

Draft.js is a JavaScript rich text editor framework, built for React. It provides a set of immutable models and helper functions for working with rich text content. Unlike @contentful/rich-text-types, which focuses on type definitions, Draft.js offers a full-fledged editor with extensive customization options.

slate

Slate is a completely customizable framework for building rich text editors. It provides a set of tools and plugins to create complex editors with various features. Slate is more focused on the editor experience, whereas @contentful/rich-text-types is focused on type safety for Contentful's rich text data.

prosemirror

ProseMirror is a toolkit for building rich text editors with a focus on performance and flexibility. It provides a set of core modules and plugins to create highly customizable editors. ProseMirror is similar to Slate in its focus on the editor experience, while @contentful/rich-text-types is more about type definitions for Contentful's rich text.

README

rich-text-types

Type definitions and constants for the Contentful rich text field type.

Changelog

14.1.2 (2020-11-02)

Bug Fixes

• 🐛 configure rollup copy correctly (3446a33)
• 🐛 skip lib check for TS (e8bf2ba)
• Add leaf object (#5) (fb0b80d)
• Add lodash.omit to externals (#7) (1c65200)
• Remove doc deployment and fix (90bccaa)

Features

• Add a default value for Marks (6828215)
• Add data transform (#6) (9d90fa1)
• Cleans up the mark property from extra props (20ec641)
• contentful-to-slate: Implement new isVoid in Slate's Node (3d2d38d)
• data defaults to an empty object (0a9b8a0)
• first version (11591d0)
• integrate structured-text-types (#8) (d6d5e37)
• remove content from void nodes (0ce9898)
• Remove nodeClass from Contentful's Document (23bb2d5)
• update dependencies (e294233)
• Update structured-text-type version (#9) (ced65da)

Performance Improvements

• ⚡️ Remove lodash.omit dependency (93b6b76)

BREAKING CHANGES

• Remove nodeClass from Contentful's Document
• Changed the interface of Slate->Contentful adapter. Added new parameter Schema
• contentful-to-slate: toSlatejsDocument now accepts Schema
• Only supports structured-text-types >= 2.0.0